home *** CD-ROM | disk | FTP | other *** search
/ Ian & Stuart's Australian Mac: Not for Sale / Another.not.for.sale (Australia).iso / fade into you / getting there / Apps / Ircle 1.5.1 folder / ircle 1.5.1 / ircle 1.5.1.rsrc / TEXT_128_ircle Help.txt < prev    next >
Text File  |  1993-11-24  |  13KB  |  165 lines
  1. Help for ircle
  2.  
  3. This is ircle, a Macintosh-based, windowed user interface to the Internet Relay Chat (IRC) network. 
  4.  
  5. This window contains:
  6. 0. Brief Overview on IRC
  7. 1. ircle Basics and Windows
  8. 2. IRC Commands and ircle Menus
  9. 3. Hints & Advice
  10. 4. General notes, Copyright Notice
  11.  
  12. 0. Brief Overview on IRC
  13. (If you know IRC, skip this section)
  14. IRC is a multi-user online chatting system. It allows users to talk to other users all around the world via the Internet. This is done by connecting a client program (such as this one) to a server. You need a connection to any network connected to the Internet and running TCP/IP, and the MacTCP network driver. You have to find out your preferred server (usually the nearest) and enter this into the Preferences dialog. The port number used by IRC servers is usually 6667.
  15. On IRC, users are identified by nicknames of their own choice. Nicknames may be at most 9 characters long.  The nickname is set via preferences or the NICK command (s.b.) If you choose a nickname already in use, you have to set a different nick. Some users have registered their nicknames with the NickServ database. If you get a message from NickServ that your nick is in use, please choose another.
  16. Communication on IRC is done via Channels and Private Messages. Channels have names starting with # and usually up to 12 characters long. You can see a list of the channels currently in use via the /LIST command. As soon as you join a channel with the /JOIN command, everything you type is sent to that channel and seen by all other users on that channel. You will see what the others type, respectively.
  17.  
  18. 1. ircle Basics and Windows
  19. ircle has a user interface similar to the traditional text-oriented IRC clients. If you know IRC, you will find it familiar. At the bottom of the screen is the input line in an own small window which also carries a line of status information. Everything you type will appear in the input line. When you press Return, the line gets sent to the current channel or, if it contains a command, that command is processed. A line is considered command if it starts with a '/' (slash). You can change this character with the /cmdchar command. See Section 2 on commands.
  20. You connect to the server via Open conection in the File menu. When the connection to the server is established, the main message window will appear. This window has your nickname in the title bar. 
  21. As soon as you join a channel, a channel window will appear with the channel name as its title. All communication done in that channel will appear in that window. If you close this window, you leave the channel.
  22. Querying a user (s.b.) will open a user window. All private messages from and to that user will appear in this window.
  23. You can switch between windows using the mouse or Command-, (comma) key. The destination of text that you type is always determined by the frontmost window, i.e. the text goes to the channel or user whose name is the frontmost window's title.
  24. The number of windows open at a time is limited only by your computer's memory and your capability of listening at many sources at a time :-)
  25. All messages not coming from or related to a channel or queried user will appear in the main message window. That can include long lists from certain commands. You can skip these by pressing Command-. (dot).
  26.  
  27. 2. IRC Commands and ircle Menus
  28. Traditionally, IRC is controlled by typing commands. A line starting with a slash is considered a command. ircle has implemented this behaviour instead of a mouse-driven environment for simplicity and user-interface compatibility to other IRC clients. Certain frequently used commands can be reached via menus. These, however, do just paste the commands into the input line and thus are shortcuts for typing the commands.
  29. The File menu has items for opening a connection, closing the topmost window (this will leave a channel), loading commands from a file, saving the current state (s.b.), setting Preferences, opening/closing a logfile and the Quit command.
  30. The Edit menu has the Copy and Paste items. Text in a window can be selected and copied, then pasted into the input line.
  31. The Commands menus contain selected IRC commands. They get just pasted into the input line and are shortcut for convenience.
  32. The Shortcuts menu provides a means for user-defined shortcuts. They can be defined in a dialog box and called via Command-0 through 9. Note that new settings work only after closing the definitions dialog.
  33. The Font menu lets you set your preferred font and size. This will affect the currently active window and all new windows opened afterwards. It also gets stored in the Set file.
  34. The Windows menu contains the titles of the active windows for fast selection.
  35.  
  36. Preferences settings and Set files
  37.  
  38. Preferences settings are stored in a Set file (formerly called Preferences file). You can start ircle with particular settings by double-clicking on the Set file. This file contains some special commands. You can view and edit this file like a text file; in particular, you can write commands into it, which will be executed on startup.
  39. The settings in the Preferences dialog are:
  40. Server: The server you want to connect to. This has to be a numeric IP address or a full host.domain name.
  41. Port: Usually 6667, when in doubt check with your server administrator.
  42. Nickname: The nickname you want to start with.
  43. Mail address: You should specify your login name or mail address on a fully qualified (with domain) machine.
  44. Real name: Your real name (or whatever evil thing you want to look like your real name)
  45. Notifications: when messages appear in an inactive window, or in any window while ircle is running in the background, you will get alerted by a sound and/or blinking menu bar item, as you can select by checking these boxes.
  46. If you choose Save Set from the File menu, your settings will be saved into a file. This includes all windows you have open, so on next startup you will join these channels.
  47.  
  48. Description of IRC Commands
  49.  
  50. The following commands are currently available: (x) = untested. 
  51. * = operator command, untested and opers should know them anyway :-)
  52. /admin nick 
  53.        server      Shows administrative info
  54. /away message      Marks you as being away (no message = not away)
  55. /bye message       Displays message and quits IRC
  56. /broadcast message Sends a message to all of your windows
  57. /channel channel   Join a channel
  58. /cmdchar c         Changes the command-prefix (default /) to the given character
  59. /connect           * Connect two servers
  60. /cping nick        Shows response time for nick
  61. /ctcp target command  Issues a CTCP command. Do /ctcp target clientinfo for more info.
  62. /date              display date/time (x)
  63. /dcc command nick  Issues a DCC command (explained below).
  64. /die               * Shut down a server
  65. /exit message      =/bye
  66. /hash              * Reconfigure a server
  67. /host              (x)
  68. /ignore pattern    ignore messages from nick!user@host (may contain wildcards)
  69.         +pattern   ignore and give the ignored a notice
  70.         -pattern   removes a pattern from the ignore list
  71. /info              gives info about server
  72. /invite nick channel invites nick to channel
  73. /join channel      =/channel
  74. /kick channel nick kicks nick from channel
  75. /kill nick         * kicks nick out of IRC
  76. /leave channel     leave a channel
  77. /links             show server connections
  78. /list              list channels
  79.       -min n       list only channels with minimum of n users
  80.       -max n                          ...  maximum of n users
  81.       -public      list only public channels
  82.       -private           ... private channels
  83.       -local             ... local channels
  84.       -global            ... global channels
  85.       -topic             ... channels with topic
  86. /lusers            display statistics
  87. /me action         sends an action description
  88. /mode channel par  set channel mode
  89.               +p   private channel
  90.               +s   secret channel
  91.               +i   invite-only channel
  92.               +m   moderated channel
  93.               +n   no messages from outside channel
  94.               +t   only channel op may set topic
  95.               +l n channel may hold at most n users
  96.         +v nick    let nick speak on moderated channel
  97.         +b nick    ban nick
  98.         +k key     set channel password
  99.         +o nick    nick becomes channel op
  100.               -x   removes flag x, where x is one of the above
  101. /mode nick par     set user mode
  102.               +i   invisible user
  103.               +s   receive server notices
  104.               +w   receive wallops
  105. /motd              show message-of-the-day
  106. /msg nick message  Sends a private message
  107. /names channel     List users on channel
  108. /nick newnick      Change your nickname
  109. /note              (x)
  110. /notice            (almost) like /msg
  111. /notify nick       Adds nick to notification list (show each signon/off)
  112.         -nick      removes nick from notification list
  113. /oper              become operator *
  114. /part channel      =/leave
  115. /query nick        open window for private messages to nick
  116. /quit message      =/bye
  117. /rehash            * Reconfigure a server
  118. /restart           * Restart a server
  119. /server srvadr     Switch to a different server
  120. /show x y          Suppress (y=OFF) or allow (y=ON) displaying of certain messages
  121.                    x is one of: join,part,quit,topic,invite,nick,mode,kick,names, or all. 
  122. /signoff message   =/bye
  123. /squit             * Remove a link between servers
  124. /stats             * Statistical info
  125. /summon user@host  Invites user@host to IRC (host must be running a server)
  126. /time              =/date
  127. /topic channel text Set a channel topic
  128. /trace             (x)
  129. /type              Type a text file to the current channel
  130. /users             (x)
  131. /version           Show server version
  132. /wallops message   Message to all operators (deprecated)
  133. /who channel       List people on channel
  134. /whois nick        Give information about user
  135. /whowas nick       Give information about user having gone
  136.  
  137. Valid commands for /dcc are:
  138. chat  - requests CHAT connection for nick or answers such a request
  139. send - send a file; tsend - send a text file
  140. get - receive a file (to be answered to a SEND request); tget - receive a text file
  141. list - list all DCC connections.
  142.  
  143. 3. Hints & Advice
  144. More information on IRC commands can be found in the 'ircle Users manual' and 'IRC Advice' files and probably in the help files for the IRCII client (but note that IRCII has a number of commands for programmability that ircle has not).
  145. When selecting a non-proportional font keep in mind that IRC was originally designed for text terminals and some commands and messages assume a fixed-size screen. That may make output look strange in some situations.
  146. This client uses the ISO Latin-1 8-bit character set and converts Macintosh special characters to this code. Some characters can not be converted and will be mapped to nonsensical characters. This also holds for DCC tsend/tget which are text-mode versions of send/get. The conversion table are those also used by Peter Lewis' FTPd.
  147. New users should check the file 'IRC Advice'.
  148.  
  149. 4. General notes, Copyright Notice
  150. This program was written by Olaf Titz (s_titz@ira.uka.de), July 1992-July 1993. You may use, copy and distribute it under the terms and conditions of the GNU General Public License, see the file COPYING that should have accompanied this program. Be sure to include the file COPYING when distributing this program.
  151.  
  152. Copyright (c) 1992,93 Olaf Titz.
  153. Some parts of this program written by Peter N. Lewis, (C) 1992.
  154. Written and compiled using THINK Pascal 2.0.1, thus Portions Copyright (C) 1988 Symantec Corp.
  155.  
  156. THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
  157.  
  158. System requirements: any Mac with System version greater 6.0 and the MacTCP driver.
  159.  
  160. This client is to fit version 2.7 and 2.8 servers. All commands and features obsoleted by 2.7 are taken out (as should be all obsolete servers by now). This client is fully compatible with the RFC1459 standard for IRC.
  161. I have still not testes all commands and special cases; there may still be some bugs, feel free to report them to me (or the alt.irc newsgroup). 
  162.  
  163. I called this ircle with a German -le suffix and spelled uncapitalized because it is rather small, and I did not put too much work into it. There are certainly IRC clients with much more functionality around, but this is runs in Mac windows, and after all, it seems to work.
  164.  
  165. Have fun!